

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
    <style>
    /* base */
    html,
    body,
    .container {
      width: 100%;
      height: 100%;
    }

    a,
    a:link,
    a:visited {
      text-decoration: none;
      color: inherit;
    }

    ul {
      list-style: none;
    }

    *,
    ::before,
    ::after {
      box-sizing: border-box;
      margin: 0;
      padding: 0;
    }

    *:focus {
      outline: 0;
    }

    .container {
      display: flex;
      padding-top: 20px;
    }

    /* Nav */
    .container .doc-nav {
      position: fixed;
      height: 100%;
      margin: 0 30px 0 40px;
      width: 280px;
    }

    .doc-nav .nav-header {
      display: flex;
      align-items: center;
      box-sizing: border-box;
      background-color: rgb(240, 241, 242);
      height: 40px;
      padding: 16px;
      font-size: 18px;
      font-weight: 500;
      color: rgb(62, 64, 66);
      cursor: pointer;
    }

    .doc-nav .nav-content {
      height: calc(100% - 40px);
      overflow-y: auto;
      color: rgb(32, 34, 36);
    }

    .doc-nav .nav-content .nav-list,
    .doc-nav .nav-content .nav-sub-list {
      line-height: 1.5rem;
    }

    .doc-nav .nav-content .nav-label {
      display: inline-block;
      position: relative;
      padding: 2px 0 2px 20px;
      margin-bottom: 4px;
    }

    .doc-nav .nav-content .nav-sub-label {
      position: relative;
      padding: 2px 0 2px 40px;
      font-size: 14px;
    }

    .doc-nav .nav-content .nav-sub-label:hover {
      text-decoration: underline;
    }

    .doc-nav .nav-content .nav-list .nav-label.group::before {
      border-bottom: 0.25rem solid transparent;
      border-left: 0.25rem solid #6e7072;
      border-right: 0;
      border-top: 0.25rem solid transparent;
      content: '';
      display: block;
      height: 0;
      left: 0.5rem;
      position: absolute;
      top: 0.625rem;
      transition: transform 0.1s linear;
      width: 0;
    }

    .doc-nav .nav-content .nav-list .nav-label.group.active::before {
      transform: rotate(90deg);
    }

    /* doc content */
    .container .doc-content {
      position: fixed;
      height: 100%;
      width: calc(100% - 80px - 40px - 30px - 240px);
      right: 0%;
      overflow-y: auto;
    }

    .doc-title {
      border-bottom: 1px solid #dcdee0;
      font-size: 22px;
      margin: 8px 0 0;
      padding-bottom: 16px;
    }

    .doc-content h3 {
      font-size: 24px;
      font-weight: 600;
      margin: 24px 0;
    }

    .doc-content h4 {
      font-size: 22px;
      font-weight: 500;
      margin: 30px 0 8px;
    }

    .doc-content h4 span {
      color: #007d9c;
    }

    .doc-content .doc-declare {
      background-color: #fafafa;
      border-radius: 5px;
      border: 1px solid #ccc;
      font-size: 14px;
      overflow-x: auto;
      padding: 10px;
      tab-size: 4;
      line-height: 20px;
    }

    .doc-content .doc-comment {
      font-size: 16px;
      margin: 16px 0;
      line-height: 24px;
      word-break: break-word;
    }
  </style>

</head>
<body>
  <div class="container">
    <div class="doc-nav">
      <a href="#Documentation" class="nav-header">Documentation</a>
      <nav class="nav-content">
        <ul class="nav-list">
          <li>
            <a href="#includes" class="nav-label">Includes</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#lwip/opt.h" class="nav-sub-label">lwip/opt.h</a>
              </li>
      

              <li>
                <a href="#lwip/altcp.h" class="nav-sub-label">lwip/altcp.h</a>
              </li>
      

              <li>
                <a href="#lwip/ip_addr.h" class="nav-sub-label">lwip/ip_addr.h</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#macros" class="nav-label">Macros</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#LWIP_HDR_ALTCP_PRIV_H" class="nav-sub-label">LWIP_HDR_ALTCP_PRIV_H</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#functions" class="nav-label">Functions</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#altcp_alloc" class="nav-sub-label">altcp_alloc</a>
              </li>
      

              <li>
                <a href="#altcp_free" class="nav-sub-label">altcp_free</a>
              </li>
      

              <li>
                <a href="#altcp_default_set_poll" class="nav-sub-label">altcp_default_set_poll</a>
              </li>
      

              <li>
                <a href="#altcp_default_recved" class="nav-sub-label">altcp_default_recved</a>
              </li>
      

              <li>
                <a href="#altcp_default_bind" class="nav-sub-label">altcp_default_bind</a>
              </li>
      

              <li>
                <a href="#altcp_default_shutdown" class="nav-sub-label">altcp_default_shutdown</a>
              </li>
      

              <li>
                <a href="#altcp_default_write" class="nav-sub-label">altcp_default_write</a>
              </li>
      

              <li>
                <a href="#altcp_default_output" class="nav-sub-label">altcp_default_output</a>
              </li>
      

              <li>
                <a href="#altcp_default_mss" class="nav-sub-label">altcp_default_mss</a>
              </li>
      

              <li>
                <a href="#altcp_default_sndbuf" class="nav-sub-label">altcp_default_sndbuf</a>
              </li>
      

              <li>
                <a href="#altcp_default_sndqueuelen" class="nav-sub-label">altcp_default_sndqueuelen</a>
              </li>
      

              <li>
                <a href="#altcp_default_nagle_disable" class="nav-sub-label">altcp_default_nagle_disable</a>
              </li>
      

              <li>
                <a href="#altcp_default_nagle_enable" class="nav-sub-label">altcp_default_nagle_enable</a>
              </li>
      

              <li>
                <a href="#altcp_default_nagle_disabled" class="nav-sub-label">altcp_default_nagle_disabled</a>
              </li>
      

              <li>
                <a href="#altcp_default_setprio" class="nav-sub-label">altcp_default_setprio</a>
              </li>
      

              <li>
                <a href="#altcp_default_dealloc" class="nav-sub-label">altcp_default_dealloc</a>
              </li>
      

              <li>
                <a href="#altcp_default_get_tcp_addrinfo" class="nav-sub-label">altcp_default_get_tcp_addrinfo</a>
              </li>
      

              <li>
                <a href="#altcp_default_get_ip" class="nav-sub-label">altcp_default_get_ip</a>
              </li>
      

              <li>
                <a href="#altcp_default_get_port" class="nav-sub-label">altcp_default_get_port</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#vars" class="nav-label">Vars</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#consts" class="nav-label">Consts</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#types" class="nav-label">Types</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="# " class="nav-sub-label"> </a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#typedefs" class="nav-label">Typedefs</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#altcp_set_poll_fn" class="nav-sub-label">altcp_set_poll_fn</a>
              </li>
      

              <li>
                <a href="#altcp_recved_fn" class="nav-sub-label">altcp_recved_fn</a>
              </li>
      

              <li>
                <a href="#altcp_bind_fn" class="nav-sub-label">altcp_bind_fn</a>
              </li>
      

              <li>
                <a href="#altcp_connect_fn" class="nav-sub-label">altcp_connect_fn</a>
              </li>
      

              <li>
                <a href="#altcp_listen_fn" class="nav-sub-label">altcp_listen_fn</a>
              </li>
      

              <li>
                <a href="#altcp_abort_fn" class="nav-sub-label">altcp_abort_fn</a>
              </li>
      

              <li>
                <a href="#altcp_close_fn" class="nav-sub-label">altcp_close_fn</a>
              </li>
      

              <li>
                <a href="#altcp_shutdown_fn" class="nav-sub-label">altcp_shutdown_fn</a>
              </li>
      

              <li>
                <a href="#altcp_write_fn" class="nav-sub-label">altcp_write_fn</a>
              </li>
      

              <li>
                <a href="#altcp_output_fn" class="nav-sub-label">altcp_output_fn</a>
              </li>
      

              <li>
                <a href="#altcp_mss_fn" class="nav-sub-label">altcp_mss_fn</a>
              </li>
      

              <li>
                <a href="#altcp_sndbuf_fn" class="nav-sub-label">altcp_sndbuf_fn</a>
              </li>
      

              <li>
                <a href="#altcp_sndqueuelen_fn" class="nav-sub-label">altcp_sndqueuelen_fn</a>
              </li>
      

              <li>
                <a href="#altcp_nagle_disable_fn" class="nav-sub-label">altcp_nagle_disable_fn</a>
              </li>
      

              <li>
                <a href="#altcp_nagle_enable_fn" class="nav-sub-label">altcp_nagle_enable_fn</a>
              </li>
      

              <li>
                <a href="#altcp_nagle_disabled_fn" class="nav-sub-label">altcp_nagle_disabled_fn</a>
              </li>
      

              <li>
                <a href="#altcp_setprio_fn" class="nav-sub-label">altcp_setprio_fn</a>
              </li>
      

              <li>
                <a href="#altcp_dealloc_fn" class="nav-sub-label">altcp_dealloc_fn</a>
              </li>
      

              <li>
                <a href="#altcp_get_tcp_addrinfo_fn" class="nav-sub-label">altcp_get_tcp_addrinfo_fn</a>
              </li>
      

              <li>
                <a href="#ip_addr_t" class="nav-sub-label">ip_addr_t</a>
              </li>
      

              <li>
                <a href="#altcp_get_port_fn" class="nav-sub-label">altcp_get_port_fn</a>
              </li>
      

              <li>
                <a href="#tcp_state" class="nav-sub-label">tcp_state</a>
              </li>
      
            </ul>
            
          </li>
        </ul>
      </nav>
    </div>
    <div class="doc-content">
      <h2 id="Documentation" class="doc-title">Documentation</h2>
      <h3 id="includes">Includes</h3>
      

      <h4 id="lwip/opt.h"><span>lwip/opt.h</span></h4>
      <pre class="doc-declare"><code>#include "lwip/opt.h"
</code></pre>
      <pre class="doc-comment">#include "lwip/opt.h"
</pre>

      <h4 id="lwip/altcp.h"><span>lwip/altcp.h</span></h4>
      <pre class="doc-declare"><code>#include "lwip/altcp.h"
</code></pre>
      <pre class="doc-comment">#include "lwip/altcp.h"
</pre>

      <h4 id="lwip/ip_addr.h"><span>lwip/ip_addr.h</span></h4>
      <pre class="doc-declare"><code>#include "lwip/ip_addr.h"
</code></pre>
      <pre class="doc-comment">#include "lwip/ip_addr.h"
</pre>
      <h3 id="macros">Macros</h3>
      

      <h4 id="LWIP_HDR_ALTCP_PRIV_H">Marco <span>LWIP_HDR_ALTCP_PRIV_H</span></h4>
      <pre class="doc-declare"><code>#define LWIP_HDR_ALTCP_PRIV_H
</code></pre>
      <pre class="doc-comment"></pre>
      <h3 id="functions">Functions</h3>
      

      <h4 id="altcp_alloc">Func <span>altcp_alloc</span></h4>
      <pre class="doc-declare"><code>struct altcp_pcb *altcp_alloc(void);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_free">Func <span>altcp_free</span></h4>
      <pre class="doc-declare"><code>void altcp_free(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_set_poll">Func <span>altcp_default_set_poll</span></h4>
      <pre class="doc-declare"><code>void altcp_default_set_poll(struct altcp_pcb *conn, u8_t interval);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_recved">Func <span>altcp_default_recved</span></h4>
      <pre class="doc-declare"><code>void altcp_default_recved(struct altcp_pcb *conn, u16_t len);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_bind">Func <span>altcp_default_bind</span></h4>
      <pre class="doc-declare"><code>err_t altcp_default_bind(struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_shutdown">Func <span>altcp_default_shutdown</span></h4>
      <pre class="doc-declare"><code>err_t altcp_default_shutdown(struct altcp_pcb *conn, int shut_rx, int shut_tx);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_write">Func <span>altcp_default_write</span></h4>
      <pre class="doc-declare"><code>err_t altcp_default_write(struct altcp_pcb *conn, const void *dataptr, u16_t len, u8_t apiflags);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_output">Func <span>altcp_default_output</span></h4>
      <pre class="doc-declare"><code>err_t altcp_default_output(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_mss">Func <span>altcp_default_mss</span></h4>
      <pre class="doc-declare"><code>u16_t altcp_default_mss(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_sndbuf">Func <span>altcp_default_sndbuf</span></h4>
      <pre class="doc-declare"><code>u16_t altcp_default_sndbuf(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_sndqueuelen">Func <span>altcp_default_sndqueuelen</span></h4>
      <pre class="doc-declare"><code>u16_t altcp_default_sndqueuelen(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_nagle_disable">Func <span>altcp_default_nagle_disable</span></h4>
      <pre class="doc-declare"><code>void altcp_default_nagle_disable(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_nagle_enable">Func <span>altcp_default_nagle_enable</span></h4>
      <pre class="doc-declare"><code>void altcp_default_nagle_enable(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_nagle_disabled">Func <span>altcp_default_nagle_disabled</span></h4>
      <pre class="doc-declare"><code>int  altcp_default_nagle_disabled(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_setprio">Func <span>altcp_default_setprio</span></h4>
      <pre class="doc-declare"><code>void altcp_default_setprio(struct altcp_pcb *conn, u8_t prio);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_dealloc">Func <span>altcp_default_dealloc</span></h4>
      <pre class="doc-declare"><code>void altcp_default_dealloc(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_get_tcp_addrinfo">Func <span>altcp_default_get_tcp_addrinfo</span></h4>
      <pre class="doc-declare"><code>err_t altcp_default_get_tcp_addrinfo(struct altcp_pcb *conn, int local, ip_addr_t *addr, u16_t *port);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_get_ip">Func <span>altcp_default_get_ip</span></h4>
      <pre class="doc-declare"><code>ip_addr_t *altcp_default_get_ip(struct altcp_pcb *conn, int local);</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_default_get_port">Func <span>altcp_default_get_port</span></h4>
      <pre class="doc-declare"><code>u16_t altcp_default_get_port(struct altcp_pcb *conn, int local);</code></pre>
      <pre class="doc-comment"></pre>
      <h3 id="vars">Vars</h3>
      
      <h3 id="consts">Consts</h3>
      
      <h3 id="types">Types</h3>
      

      <h4 id=" ">Type <span> </span></h4>
      <pre class="doc-declare"><code>enum tcp_state altcp_default_dbg_get_tcp_state(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>
      <h3 id="typedefs">Typedefs</h3>
      

      <h4 id="altcp_set_poll_fn">Typedef <span>altcp_set_poll_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_set_poll_fn)(struct altcp_pcb *conn, u8_t interval);
</code></pre>
      <pre class="doc-comment">/* Function prototypes for application layers */</pre>

      <h4 id="altcp_recved_fn">Typedef <span>altcp_recved_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_recved_fn)(struct altcp_pcb *conn, u16_t len);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_bind_fn">Typedef <span>altcp_bind_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_bind_fn)(struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_connect_fn">Typedef <span>altcp_connect_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_connect_fn)(struct altcp_pcb *conn, const ip_addr_t *ipaddr, u16_t port, altcp_connected_fn connected);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_listen_fn">Typedef <span>altcp_listen_fn</span></h4>
      <pre class="doc-declare"><code>typedef struct altcp_pcb *(*altcp_listen_fn)(struct altcp_pcb *conn, u8_t backlog, err_t *err);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_abort_fn">Typedef <span>altcp_abort_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_abort_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_close_fn">Typedef <span>altcp_close_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_close_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_shutdown_fn">Typedef <span>altcp_shutdown_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_shutdown_fn)(struct altcp_pcb *conn, int shut_rx, int shut_tx);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_write_fn">Typedef <span>altcp_write_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_write_fn)(struct altcp_pcb *conn, const void *dataptr, u16_t len, u8_t apiflags);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_output_fn">Typedef <span>altcp_output_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_output_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_mss_fn">Typedef <span>altcp_mss_fn</span></h4>
      <pre class="doc-declare"><code>typedef u16_t (*altcp_mss_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_sndbuf_fn">Typedef <span>altcp_sndbuf_fn</span></h4>
      <pre class="doc-declare"><code>typedef u16_t (*altcp_sndbuf_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_sndqueuelen_fn">Typedef <span>altcp_sndqueuelen_fn</span></h4>
      <pre class="doc-declare"><code>typedef u16_t (*altcp_sndqueuelen_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_nagle_disable_fn">Typedef <span>altcp_nagle_disable_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_nagle_disable_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_nagle_enable_fn">Typedef <span>altcp_nagle_enable_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_nagle_enable_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_nagle_disabled_fn">Typedef <span>altcp_nagle_disabled_fn</span></h4>
      <pre class="doc-declare"><code>typedef int  (*altcp_nagle_disabled_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_setprio_fn">Typedef <span>altcp_setprio_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_setprio_fn)(struct altcp_pcb *conn, u8_t prio);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_dealloc_fn">Typedef <span>altcp_dealloc_fn</span></h4>
      <pre class="doc-declare"><code>typedef void (*altcp_dealloc_fn)(struct altcp_pcb *conn);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_get_tcp_addrinfo_fn">Typedef <span>altcp_get_tcp_addrinfo_fn</span></h4>
      <pre class="doc-declare"><code>typedef err_t (*altcp_get_tcp_addrinfo_fn)(struct altcp_pcb *conn, int local, ip_addr_t *addr, u16_t *port);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="ip_addr_t">Typedef <span>ip_addr_t</span></h4>
      <pre class="doc-declare"><code>typedef ip_addr_t *(*altcp_get_ip_fn)(struct altcp_pcb *conn, int local);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="altcp_get_port_fn">Typedef <span>altcp_get_port_fn</span></h4>
      <pre class="doc-declare"><code>typedef u16_t (*altcp_get_port_fn)(struct altcp_pcb *conn, int local);
</code></pre>
      <pre class="doc-comment"></pre>

      <h4 id="tcp_state">Typedef <span>tcp_state</span></h4>
      <pre class="doc-declare"><code>typedef enum tcp_state (*altcp_dbg_get_tcp_state_fn)(struct altcp_pcb *conn);</code></pre>
      <pre class="doc-comment"></pre>
    </div>
  </body>
</html>
            